home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 6 / The Arsenal Files 6 (Arsenal Computer).ISO / os2bbs / mxl220.zip / MAXLIST.DOC < prev    next >
Text File  |  1996-02-17  |  60KB  |  1,449 lines
  1.  ┌╦═══════════════════════════════════════════════════════════════════ ┌╦═══╦┐
  2.  │║     ┌╦   ╦┐┌╦   ╦┐┌╦═╦═╦┐┌╦═╦═╦┐┌╦     ┌╦═══╦┐       ┌╦══╦┐ ┌╦══╦┐ │║   ╩┘
  3.  └╩═══╦┐├╬═══╬┤│║   ║│   ║      ║   │║     ├╬══          │╠══╩╦┐│╠══╩╦┐└╩═══╦┐
  4.  ┌╦   ║│└╩   ╩┘└╩═══╩┘   ╩      ╩   └╩═══╩┘└╩═══╩┘       └╩═══╩┘└╩═══╩┘     ║│
  5.  └╩═══╩┘ ════════════════════  H A T T I N G E N  ══════════════════════════╩┘
  6.   ▓▒░             ───────────────────────────────────────────             ░▒▓
  7.   ▓▒░─────────────▓▒░  HOME OF MAXLIST FILELISTPROCESSOR  ░▒▓─────────────░▒▓
  8.   ▓▒░             ───────────────────────────────────────────             ░▒▓
  9.   ═══════════════════════════════════════════════════════════════════════════
  10.   ▓▒░                                                                     ░▒▓
  11.   ▓▒░     ┌──────┐ ┌──────┐ ┌─┐  ┌─┐ ┌─┐      ┌─┐ ┌──────┐ ┌───────┐      ░▒▓
  12.   ▓▒░     └──────┘ └──────┘ └─┘  └─┘ └─┘      └─┘ └──────┘ └───────┘      ░▒▓
  13.   ▓▒░     ┌─┐┌┐┌─┐ ┌──────┐   ┌──┐   ┌─┐      ┌─┐ ┌──────┐    ┌─┐         ░▒▓
  14.   ▓▒░     │ │└┘│ │ │ ┌──┐ │  ┌┘┌┐└┐  │ │      │ │ └────┐ │    │ │         ░▒▓
  15.   ▓▒░     │ │  │ │ │ │  │ │ ┌┘┌┘└┐└┐ │ └────┐ │ │ ┌────┘ │    │ │         ░▒▓
  16.   ▓▒░     └─┘  └─┘ └─┘  └─┘ └─┘  └─┘ └──────┘ └─┘ └──────┘    └─┘         ░▒▓
  17.   ▓▒░     Template controlled Filebaseprozessor for Maximus Systems       ░▒▓
  18.   ▓▒░     Version 2.20      Copyright 1994-96 by Wilfried Brinkmann       ░▒▓
  19.   ▓▒░                                                                     ░▒▓
  20.  ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ All rights reserved ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  21.  ═════════════════════════════════════════════════════════════════════════════
  22.  
  23.     ─╥────┐ ╓──┐ ╓──┐ ╥  ┬ ╓─╥─┐ ╥──┐ ╓──┐ ╓─╥─┐ ╓──┐ ╓─╥─┐ ─╥─ ╓──┐ ╓──┐
  24.      ║    │ ║  │ ║    ║  │ ║ ║ │ ╟─   ║  │   ║   ╟──┤   ║    ║  ║  │ ║  │
  25.      ║    │ ╙──┘ ╙──┘ ╙──┘ ╨ ╨ ┴ ╨──┘ ╨  ┴   ╨   ╨  ┴   ╨   ─╨─ ╙──┘ ╨  ┴
  26.      ║    │ ─────────  MaxList Version 2.20 Dos, DPMI and OS/2  ─────────
  27.     ─╨────┘ 
  28.  
  29.  ┌───────────────────╖
  30.  │ Importend note !! ╠════════════════════════════════════════════════════════
  31.  ╘═══════════════════╝
  32.  
  33.     I have invested SO MUCH time and work for this program. Please honor
  34.     my work and send me a 'freewilling' gift as you want.
  35.  
  36.     For the last year, it has shown, only a few Sysops are ready to honor
  37.     my work. Therefore the following hint:
  38.  
  39.           It's in your hand, if MaxList still keeps 'Requestware' !
  40.  
  41.     ▓▒░─────────────────────────────────────────────────────────────────░▒▓
  42.     ▓▒░ Adress:                        Bank-Account:                    ░▒▓
  43.     ▓▒░   Wilfried Brinkmann             Genossenschafts-Bank Essen eG  ░▒▓
  44.     ▓▒░   Im Tal 136                     BLZ: 360 604 88                ░▒▓
  45.     ▓▒░   45529 Hattingen (Germany)      KTO: 114 713 501               ░▒▓
  46.     ▓▒░─────────────────────────────────────────────────────────────────░▒▓
  47.  
  48.  
  49.  ┌──────────╖
  50.  │ Warranty ╠═════════════════════════════════════════════════════════════════
  51.  ╘══════════╝
  52.  
  53.     No warranty is taken for this software, neither expressed or implied,
  54.     especially for correct function or usability for a certain purpose.
  55.     The author is not responsible for any damages caused by the usage of
  56.     this software. YOU as user of MaxList carry the full risk for usability
  57.     and reliability.
  58.     The only warranty I can give is that this program will consume some
  59.     space on your hard disk.
  60.     I will try my best to remove errors I am informed about, as far as I
  61.     get enough information on an error.
  62.  
  63.     IF YOU DO NOT AGREE WITH THESE CONDITIONS, YOU MUST NOT USE THIS PROGRAM!
  64.  
  65.  
  66.  ┌─────────────────────────────╖
  67.  │ Support in case of problems ╠══════════════════════════════════════════════
  68.  ╘═════════════════════════════╝
  69.  
  70.     VOICE-SUPPORT:
  71.       Call +49-2324-42350 and get help free of charge.
  72.       You may call this number daily between 10:00 and 22:00 MET/MEST, but
  73.       take into consideration, that I will not always be there.
  74.  
  75.     NETMAIL-SUPPORT:
  76.       Send me a netmail with your questions. You may avoid eventual
  77.       check-back, when you include the relevant parts of your configuration
  78.       file.
  79.       Answers will normally be sent a routed netmail. Crashmail is only used
  80.       in exceptional cases.
  81.  
  82.       You will reach me in FidoNet at 2:2444/2050, OS2Net at 81:449/2025
  83.       and Internet (wilfried.brinkmann@shuttle.mediaserve.de)
  84.  
  85.     HINT!
  86.       For additional Supportnodes please read the file REGISTER.TXT
  87.  
  88.  
  89.  ┌─────────╖
  90.  │ Credits ╠══════════════════════════════════════════════════════════════════
  91.  ╘═════════╝
  92.  
  93.     I want to express my thank to all who have tested MaxList on a
  94.     voluntary basis and detailly reported errors and gave constructive
  95.     improvement suggestions. Without their help MaxList would not have
  96.     been that successful.
  97.  
  98.  
  99.  ┌─────────────────╖
  100.  │ Copyright Notes ╠══════════════════════════════════════════════════════════
  101.  ╘═════════════════╝
  102.  
  103.     The following names, programs and products are mentioned in this 
  104.     documentation and are protected by law:
  105.  
  106.         4OS2                    JP Software Inc.
  107.         Binkley                 Bit Bucket Software Co.
  108.         CantaLoup               Buenter Communucations
  109.         Borland                 Borland International Inc.
  110.         Maximus, Squish         Scott J. Dudley
  111.         MS-DOS                  Microsoft Corporation
  112.         OS/2                    IBM Corporation
  113.         PkZip                   PKWARE Inc.
  114.  
  115.  
  116.  ┌───────────────────╖
  117.  │ Common Directions ╠════════════════════════════════════════════════════════
  118.  ╘═══════════════════╝
  119.  
  120.     The format of EVERY filelist and EVERY FILES.BBS is controlled
  121.     without execption by the configured TEMPLATES.
  122.  
  123.     These templates contain all instructions how MaxList will handle
  124.     and format the data contained in your filebase.
  125.  
  126.     In either case you should therefore carefully read the TEMPLATE.DOC
  127.     before modifying the configuration files.
  128.  
  129.     MaxList uses the FILEAREA.CTL file of Maximus to generate the file
  130.     lists. Additional control files may be included there by using the
  131.     INCLUDE statement of Max.
  132.  
  133.     MaxList can create announcelists. It compares each file with the
  134.     Maximus index (MAXFILES.IDX) to check if this file exist in filebase.
  135.  
  136.     MaxList supports archiver programs directly. This means that the
  137.     generated file lists are packed automatically, without user
  138.     intervention. The parameters needed for the archivers are defined in
  139.     the file COMPRESS.CFG, which has the same format as those used by
  140.     Maximus and Squish.
  141.  
  142.     MaxList is able to add orphan files automatically to the file lists
  143.     and/or the FILES.BBS (Keyword AddOrphanFiles). When the orphan file
  144.     contains a FILE_ID.DIZ, this one will be used for the description.
  145.  
  146.     Furthermore a (small) editor is integrated in MaxList, letting you
  147.     manually insert file descriptions for orphan files. The descriptions
  148.     may also be taken from a FILE_ID.DIZ in this case.
  149.  
  150.     MaxList supports long OS/2 HPFS file- and pathnames. Only one
  151.     restriction exists: these names may not contain blanks.
  152.     NOTE:
  153.       The files of your filebase (those contained in your FILES.BBS)
  154.       must have names following the DOS 8.3 convention. Long names
  155.       are not supported here.
  156.  
  157.     The date to be shown in the lists can either be the "LastWriteDate"
  158.     (DOS) or the "FileCreationDate" (OS/2 HPFS only!)
  159.  
  160.  
  161.  ┌─────────────────────────────────────────────────────────╖
  162.  │ Syntax being used in configuration, wildcard characters ╠══════════════════
  163.  ╘═════════════════════════════════════════════════════════╝
  164.  
  165.     Parameters which may no be omitted are represented in pointed
  166.     parentheses, e.g. <Area>, optional parameters are represented by
  167.     brackets, e.g. [Option]
  168.  
  169.     Most parameters may contain wildcard characters (? and *).
  170.     Area tags may be given as range, e.g. 100..200.
  171.     NOTE:       When using the range format, wildcards are not allowed!
  172.  
  173.     Area parameters may be given as area tags as well as a combination of
  174.     group and area.
  175.  
  176.     If you have the group GFD.APP and inside it the area with tag TOOL,
  177.     you may use GFD.APP.TOOL to name this area. Of course you may use
  178.     wildcards here. For example the parameter GFD.ALL.* will tell to use
  179.     all areas following after GFD.APP; the area GFD.APP.ARC.XYZ will
  180.     match this parameter.
  181.  
  182.     Maximus AccessLevel and keys are handled seperately for each area or
  183.     group. Wildcards are allowed. Using xxACS */P will match all
  184.     areas/groups containing a P in the key list (e.g. Normal/ACPX).
  185.  
  186.  
  187.  ┌───────────────────────╖
  188.  │ Newfiles announcement ╠════════════════════════════════════════════════════
  189.  ╘═══════════════════════╝
  190.  
  191.     MaxList is capable to create announcelists and write this as a Echomail
  192.     directly to your Squish mailbase. 
  193.     If a list is greater than 32 Kbytes, this is splitted in more mails.
  194.     The Subjectline is expanded with a 'Page/Pages' notice, e.g. [1/4].
  195.     At the end of message the string '>Continue on next page<' is inserted
  196.     and also at top of next page the string '>Continue from previouse page<'.
  197.     All messageparameters (Your AKA, From, To, Subject and Origin) is full
  198.     controlled by you. For more info about this, see 'SQUISHMAIL'. 
  199.     MaxList can also create a 'Echtoss' logfile for your tosser.
  200.     For more info, see 'EchoTossLog'.
  201.  
  202.     To find out if a file is 'new', MaxList compares each file with the
  203.     Maximus index (MAXFILES.IDX). Is the file not found, then this will be
  204.     written to the announcelist.
  205.     
  206.     Every time you starts MaxList, this list is deleted. A new list is
  207.     created only, when one or more new files will be found.
  208.     When you starts FB(p) after each run of MaxList, then you have the
  209.     warranty, that only 'new' files resides in announcelist.
  210.  
  211.     Hint:
  212.     ─────
  213.     Areas with TYPE CD or DATELIST are never scanned.
  214.     MaxList can't create a new Squishbase! The Squishecho, which is used
  215.     for announcemails must exist on your system.
  216.  
  217.  
  218.  ┌──────────────────────────────────────────────────────╖
  219.  │ Controlling flow by using IF / IFN, ELSEIF and ENDIF ╠═════════════════════
  220.  ╘══════════════════════════════════════════════════════╝
  221.  
  222.     IF <expression> resp. IFN <expression> may be involved as you like,
  223.     e.g.:
  224.         IF <expr>
  225.             ...
  226.           IF <expr>
  227.             ...
  228.           ENDIF
  229.             ...
  230.         ENDIF
  231.  
  232.     The following internal expressions are available:
  233.  
  234.         DOS         - True, when MaxList is running under DOS or a VDM
  235.         OS2         - True, when MaxList is running under OS/2
  236.         IMPORT      - True, when command line parameter -I was specified
  237.         SPECIAL     - True, when command line parameter -S was specified
  238.         DUPECHECK   - True, when command line parameter -D was specified
  239.  
  240.     In addition you may define your own variables and use these in an
  241.     expression. The variables can be set by the DEFINE statement or are
  242.     tried to be resolved from the programs environment (so you may define
  243.     environment variables before starting MaxList and access these from
  244.     within MaxList!)
  245.  
  246.     NOTE:       Contens of variables are case sensitive!
  247.     Example:
  248.     ────────
  249.       IF TestVar Yes    - True, when TestVar contains Yes
  250.       IFN TestVar Yes   - True, when TestVar does NOT contain Yes
  251.       IF TestVar YES    - False, when TestVar contains Yes (casesensitive)
  252.  
  253.     The switches DOS and OS2 can also stand in front of each keyword.
  254.     This line is processed only, if <switch> true.
  255.     Example:
  256.     ────────
  257.         DOS Execute &D:\MAX\FB.EXE
  258.         OS2 Execute &D:\MAX\FBP.EXE
  259.  
  260.  
  261.  ┌──────────────────────────────────────────╖
  262.  │ Including additional configuration files ╠═════════════════════════════════
  263.  ╘══════════════════════════════════════════╝
  264.  
  265.     Using INCLUDE <d:\path\filename.ext> tells MaxList to include additional
  266.     configuration parts at this place. Up to 10 levels of inludes are
  267.     supported (i.e. the included file contains again a INCLUDE).
  268.  
  269.  
  270.  ┌────────────────────────────────────╖
  271.  │ Command line parameters of MaxList ╠═══════════════════════════════════════
  272.  ╘════════════════════════════════════╝
  273.  
  274.     MaxList recognizes several (optional) parameters at its command line.
  275.     All parameters may be used simultaneously, no matter of the order.
  276.     The parameters are detected by the leading slash (/) or dash (-).
  277.  
  278.       /C, -C      specify alternative configuration file
  279.       Usage:  MAXLIST(P) -Cd:\path\config.ext
  280.  
  281.       /D, -D      activate dupe checking
  282.       Usage:  MAXLIST(P) -D
  283.  
  284.         MaxList includes the possibility to check your file base for dupes.
  285.         When -D is specified, the internal switch DUPECHECK is set to true
  286.         and may be used in an IF / IFN expression.
  287.         The way how a dupe check is performed may be set by keyword DUPECHECK
  288.         in the configuration file. In addition the definition for a file list
  289.         DUPE must be present, otherwise NO dupe check will be done!
  290.  
  291.       /S, -S      switch to special mode
  292.       Usage:  MAXLIST(P) -S
  293.  
  294.         MaxList has a special mode. When it is active, the internal switch
  295.         SPECIAL is set to true and may be used in an IF / IFN expression.
  296.         The original intention for this option was to give an easy way to
  297.         generate file lists for a filebase laying on CD-ROM. As this one is
  298.         normally not modified, or if you have several CD-ROMs, you may use
  299.         this to create the file list for a CD-ROM by starting MaxList with
  300.         option -S. I have defined the CD-ROM file list definition within an
  301.         IF SPECIAL ... ENDIF block and exluded the areas on CD-ROM by
  302.         IFN SPECIAL and NOPROCESS for normal processing.
  303.  
  304.       /I, -I      switch to automatic import mode for descriptions
  305.       Usage:  MAXLIST(P) -I[=Area[..Area]]
  306.  
  307.         When this option is specified, MaxList will import the description
  308.         for ALL files of your filebase from a FILE_ID.DIZ in the archive.
  309.         Optional you may restrict this function to some areas by adding an
  310.         area or an =area..area directly behind the -I. When using =area,
  311.         wildcards are allowed.
  312.         You may specify the areas to exclude from this processing also by
  313.         using the keyword IMPORT in the configuration.
  314.  
  315.       /M, -M      manual description import
  316.       Usage:  MAXLIST(P) -M
  317.  
  318.         This option activate the (small) internal editor of MaxList, and also
  319.         the choosen editor under the token 'ExternEditor'.
  320.         When no FILE_ID.DIZ is found in AddOrphanFiles mode, you may enter a
  321.         (up to 10 lines long) description for the corresponding file.
  322.         Is a FILE_ID.DIZ found, the external editor is started with this file.
  323.  
  324.       /?, -?, ?   MaxList help
  325.       Usage:  MAXLIST(P) -?
  326.  
  327.         Will give you a short description of all command line parameters.
  328.  
  329.  
  330.  ┌────────────────────────────────────────╖
  331.  │ MaxLists integrated description editor ╠═══════════════════════════════════
  332.  ╘════════════════════════════════════════╝
  333.  
  334.     MaxList contains a simple editor for adding file descriptions manually
  335.     in AddOrphanFiles mode, when no FILE_ID.DIZ was found in an archive.
  336.     Editing existing file descriptions is only possible, you have used the
  337.     token 'ExternEditor'
  338.  
  339.     The editor will start automatically when command line parameter -M
  340.     was given. The following keys are supported in the editor:
  341.  
  342.       cursor keys Up, Down, Left, Right - moves the cursor
  343.       Pos1 or Home                      - move cursor to start of line
  344.       End                               - move cursor to end of line
  345.       PageUp (PgUp)                     - move cursor to first line
  346.       PageDown (PgDn)                   - move cursor to last line
  347.       Strg-N or Ctrl-N                  - insert a blank line
  348.       Strg-Y or Ctrl-Y                  - delete line
  349.       Del                               - delete character at cursor
  350.       BS (Backspace)                    - delete characted left to cursor
  351.       F2                                - save and exit
  352.       F3                                - save and add description as 
  353.                                           FILE_ID.DIZ to the archive
  354.       ESC                               - cancel
  355.  
  356.     When the description is saved by F3, MaxList will try to add the desc
  357.     as file FILE_ID.DIZ to the archive. The date of the FILE_ID.DIZ is set
  358.     to the date of the archive in this case.
  359.  
  360.     When no description is entered, or the editor is canceled by ESC, the
  361.     string defined by keyword NODESCRIPTION is written to the FILES.BBS.
  362.  
  363.  
  364.  ┌────────────────────────────────────╖
  365.  │ Full path names in FILES.BBS files ╠═══════════════════════════════════════
  366.  ╘════════════════════════════════════╝
  367.  
  368.     MaxList recognizes files with a path in the FILES.BBS files and processes
  369.     them correctly. This has no effects the length of the description.
  370.     (BTW: Maximus is also able to handle such entries correctly).
  371.     The path of the file will nor occur in the file list. Only the filename
  372.     will be present here.
  373.  
  374.  
  375.  ┌─────────────────────────╖
  376.  │ MaxList and Maximus 3.0 ╠══════════════════════════════════════════════════
  377.  ╘═════════════════════════╝
  378.  
  379.     MaxList is able to cooperate with EVERY version of Maximus.
  380.     It will silently ignore unknown Maximus instructions.
  381.  
  382.     The TYPE instruction of Maximus 3.0
  383.     ───────────────────────────────────
  384.  
  385.     MaxList supports a special form of FILES.BBS, which is defined by 
  386.     TYPE DATELIST at Maximus 3.0. This FILES.BBS contains file date and size
  387.     in addition to the usual entries.
  388.  
  389.     When you have defined an area as TYPE DATELIST in your FILEAREA.CTL,
  390.     MaxList will not try to evaluate file size and date from the file, but
  391.     use the given values instead. The data in the FILES.BBS is converted to
  392.     the internal format n you have defined an area as TYPE DATELIST in your
  393.     FILEAREA.CTL, MaxList will not try to evaluate file size and date from
  394.     the file, but use the given values instead. The data in the FILES.BBS is
  395.     converted to the internal format and will be put in the file list as
  396.     specified in the corresponding TEMPLATE. MaxList expects the file size
  397.     after the filename, followed by the file date. The file size is ALWAYS
  398.     expected in bytes.
  399.     
  400.     You need to define a special template for FILES.BBS following TYPE
  401.     DATELIST format. Additional information on this topic is located in
  402.     TEMPLATE.DOC.
  403.  
  404.     When the file size and date is MISSING, MaxList will evaluate them from
  405.     the file directly. In this special case MaxList behaves as if no TYPE
  406.     DATELIST was found.
  407.  
  408.     Areas marked as TYPE DATELIST will NEVER be processed for RemoveOffline
  409.     and RemoveOldFile. The flags for the age of a file are brought up to date
  410.     every time MaxList runs.
  411.  
  412.  
  413.  ═════════════════════════════════════════════════════════════════════════════
  414.  
  415.      ╓─────┐ ╓──┐ ╓──┐ ╥──┐ ─╥─ ╓──┐ ╥  ┬ ╥──┐ ╓──┐ ╓─╥─┐ ─╥─ ╓──┐ ╓──┐
  416.      ║       ║  │ ║  │ ╟─    ║  ║ ─┐ ║  │ ╟─┬┘ ╟──┤   ║    ║  ║  │ ║  │
  417.      ║       ╙──┘ ╨  ┴ ╨    ─╨─ ╙──┘ ╙──┘ ╨ ┴  ╨  ┴   ╨   ─╨─ ╙──┘ ╨  ┴
  418.      ║       ────────  MaxList Version 2.20 Dos, DPMI and OS/2 ────────
  419.      ╙─────┘
  420.  
  421.  
  422.  ┌────────────────────────────────────╖
  423.  │ Your Name and Key for Registration ╠═══════════════════════════════════════
  424.  ╘════════════════════════════════════╝
  425.     
  426.     ┌─────────
  427.     │ UserName      "Your Name"
  428.     └──────────────────────────
  429.     Here you must enter your name as given in registration
  430.     
  431. UserName            "John Doe"
  432.  
  433.     ┌───────
  434.     │ RegKey        <Hexadecimal keycode>
  435.     └────────────────────────────────────
  436.     Here you must enter your Keycode as given in registration
  437.  
  438. RegKey              1234567890ABCDEF1234567890ABCD
  439.  
  440.  
  441.  ┌───────────────────────────────────╖
  442.  │ Assignment of Variables by DEFINE ╠════════════════════════════════════════
  443.  ╘═══════════════════════════════════╝
  444.  
  445.     ┌───────
  446.     │ Define    <Name_of_Variable>  <Value>
  447.     └──────────────────────────────────────
  448.       Multiple usage possible
  449.  
  450.     Via DEFINE you can assign a free value to a variable. The name of the
  451.     variable is free, too. You may then access the value, equivalent to
  452.     accessing environment variables, later on in the configuration.
  453.     When MaxList will find a string enclosed in a percent sign (e.g %TEST%),
  454.     the whole string will be substituted by the value of that variable.
  455.         
  456. Define              ListDir         E:\Listen
  457. Define              MxLDir          D:\FileList
  458. Define              Template        %MxLDir%\Template
  459. Define              Font            %MxLDir%\Font\digi3x5.fnt
  460. Define              Flags           D:\BINK\FLAGS
  461. Define              Task1           %Flags%\Task.01
  462. Define              Task2           %Flags%\Task.02
  463. Define              Task3           %Flags%\Task.03
  464. Define              Task0           %Flags%\Task.00
  465. Define              TaskMax1        %Flags%\Maximus.01
  466. Define              TaskMax2        %Flags%\Maximus.02
  467. Define              TaskMax3        %Flags%\Maximus.03
  468.  
  469.  ┌──────────────────────╖
  470.  │ Archiver Definitions ╠═════════════════════════════════════════════════════
  471.  ╘══════════════════════╝
  472.  
  473.     MaxList uses an ascii file for defining the archiver parameters and more.
  474.     This file is 100% compatible to that one used by Squish and Maximus.
  475.  
  476. Include             %MxlDir%\archiver.cfg
  477.  
  478.  ┌─────────────────────────╖
  479.  │ Start External Programs ╠══════════════════════════════════════════════════
  480.  ╘═════════════════════════╝
  481.  
  482.     ┌────────
  483.     │ Execute  [& | ^]<programm [parameter]>
  484.     └───────────────────────────────────────
  485.       Multiple usage possible
  486.  
  487.     Using the Execute command you can tell MaxList to start any external
  488.     programs after all file list processing is completed.
  489.     When the program name is preceded by an "&", MaxList will change the
  490.     current path to that of the program before starting it.
  491.     In addition you can place a "^" in front of the command line, this will
  492.     redirect all output to NUL (i.e. suppress display of program output).
  493.  
  494.     User of OS/2 may use the 'START "WinTitle" /FG ...' command for starting
  495.     programs. If you do not like to have the whole string in the log file,
  496.     you may exclude the parts you don't want to see by putting them in
  497.     brackets []: 
  498.         [Start "FBP" /FG /C /Pos=1,1,25,80] &D:\MAX\FBP.EXE
  499.     The log will only contain "Call D:\MAX\FBP.EXE" then.
  500.  
  501. ifn DupeCheck
  502.  if OS2
  503.   Execute           &D:\MAX\FBP.EXE
  504.   Execute           &D:\MAX\OKF.EXE Dupe
  505.  EndIf
  506. EndIf
  507.  
  508.  ┌─────────────────╖
  509.  │ Global Settings ╠══════════════════════════════════════════════════════════
  510.  ╘═════════════════╝
  511.  
  512.     ┌───────
  513.     │ Debugg            <Yes | No>
  514.     └─────────────────────────────
  515.     This is for testing purposes.
  516.     When Debugg = Yes, MaxList will NOT alter any FILES.BBS. Instead, it
  517.     will generate a FILES.$$$, where you can check how the FILES.BBS files
  518.     are processed and how it would look like. If you set Debugg to No again,
  519.     the temporary FILES.$$$ files again are automatically deleted.
  520.  
  521. Debugg              Yes
  522.  
  523.     ┌────────────
  524.     │ WaitIfError       <Yes | No>
  525.     └─────────────────────────────
  526.     MaxList will wait for any key to be pressed when any error occurs, if
  527.     this is set to Yes. In case of error the "SemaphoreRun" will be deleted
  528.     (so that other programs will not wait unnecessarily) and all time slices
  529.     are released.
  530.  
  531. WaitIfError         Yes
  532.  
  533.     ┌───────────────
  534.     │ RedirectOutput    <Yes | No>
  535.     └─────────────────────────────
  536.     If set to Yes, MaxList will redirect the output of an archiver to NUL
  537.     (e.g. when importing the FILE_ID.DIZ).
  538.  
  539. RedirectOutput      Yes
  540.  
  541.     ┌─────────────────
  542.     │ UseFileDivisions  <Yes | No>
  543.     └─────────────────────────────
  544.     If you use Maximus 3.0, you probably use the new feature to build file
  545.     divisions. If you like to get a "flat" file list, i.e. without grouping
  546.     areas into divisions, you have to specify No here.
  547.     For Maximus 2.XX users, this keyword will have no effects.
  548.  
  549. UseFileDivision     Yes
  550.  
  551.     ┌─────────────────
  552.     │ UseFCreationDate  <Yes | No>
  553.     └─────────────────────────────
  554.     When you use HPFS in OS/2, you have the choice to select from two kind of
  555.     file dates: "LastWriteDate"  -> No, "FileCreationDate" -> Yes.
  556.     The file date you select here will be printed in the lists and it is used
  557.     for new files check.
  558.     NOTE
  559.       On a FAT file system, du NOT use this parameter, otherwise all time
  560.       and date distributions are damaged !
  561.  
  562. UseFCreationDate    No
  563.  
  564.     ┌─────────────────
  565.     │ MainGroupAtFront  <Yes | No>
  566.     └─────────────────────────────
  567.     When you have file divisions active, but use some areas which are not
  568.     within any file division, you can set here wether to put these areas to
  569.     top of the lists (Yes) or to the end (No).
  570.  
  571. MainGroupAtFront    No
  572.  
  573.     ┌───────────
  574.     │ AddComment        <Yes | No>
  575.     └─────────────────────────────
  576.     Comments contained in FILES.BBS files are supressed in the file lists,
  577.     if you specify NO here. The command will have no effect on the FILES.BBS
  578.     files. MaxList recognizes comments following the next two rules:
  579.       a) first char of a line is a dash (-)  or
  580.       b) first line is blank (only CrLf at start), followed by lines that
  581.          have at least one blank as first character and a last line (before
  582.          next file name), that is a blank line again (CrLf at start of line).
  583.  
  584.     Example:
  585.       a)    FILE1.EXT  This is the first file
  586.             - ═════════════
  587.             - Comment
  588.             - ═════════════
  589.             FILE2.EXT  This is the second file
  590.  
  591.       b)    FILE1.EXT  This is the first file
  592.  
  593.             ═════════════
  594.             Comment
  595.             ═════════════
  596.  
  597.             FILE2.EXT  This is the second file
  598.  
  599.     Dashes (-) in comment lines are substituted by blanks in the file lists,
  600.     if they are not followed by another dash.
  601.  
  602. AddComment          Yes
  603.  
  604.     ┌──────────────
  605.     │ UseMaxHomeDir     <Yes | No>
  606.     └─────────────────────────────
  607.     If a relative path is specified in your FILEAREA.CTL file behind the
  608.     keywords DOWNLOAD or FILELIST, i.e. a pathname WITHOUT a drive letter,
  609.     MaxList is able to extend this by using the path to the first
  610.     FILEAREA.CTL file.
  611.     If you specified MaxAreaFile  D:\MAX\FILEAREA.CTL in this config, MaxList
  612.     will extend the entry DOWNLOAD BBS\LISTS to D:\MAX\BBS\LISTS, if
  613.     UseMaxHomeDir is set to Yes.
  614.  
  615. UseMaxHomeDir       No
  616.  
  617.     ┌──────────
  618.     │ DLCounter         <String>
  619.     └───────────────────────────
  620.     If the token @DlCounter is used in a template, MaxList will replace it by
  621.     the string you specify here, if none is present in the FILES.BBS.
  622.     An existing download counter is not changed.
  623.     Furthermore, this entry is needed to remove existing download counters.
  624.     When a FILES.BBS contains a download counter, but the template does not
  625.     have a @DLCOUNTER token, MaxList will remove it, when it uses the frame
  626.     characters of the string specified here.
  627.     For additional information see TEMPLATE.DOC.
  628.  
  629. DLCounter           [00]
  630.  
  631.     ┌─────────
  632.     │ FlagChar          <days, character>  <days, character> ..
  633.     └──────────────────────────────────────────────────────────
  634.     For emphasizing new files you may specify several flags here.
  635.     When a file is newer than <days>, the specified flag character is used.
  636.     Between each pair of <days, character> you have to put at least one blank.
  637.  
  638. FlagChar            7,√  14,*  30,+
  639.  
  640.     ┌─────────────────
  641.     │ BBSWildcardFiles  <ALL | NEW>
  642.     └──────────────────────────────
  643.     In a FILES.BBS file names may contain wildcard characters.
  644.     In that case, MaxList will either list all files matching <ALL> or only
  645.     the newest file <NEW>.
  646.     The FILES.BBS is not changed, the wildcards stay in it.
  647.     NOTE
  648.       A FILES.BBS of TYPE DATELIST must not contain any wildcard character.
  649.       If one is found, it will be placed AS IS into the file lists!
  650.  
  651. BBSWildCardFiles    All
  652.  
  653.     ┌──────────────
  654.     │ NoDescription     <String>
  655.     └───────────────────────────
  656.     <String> will be used for files where no description is available.
  657.     It may not exceed 255 characters in length.
  658.  
  659. NoDescription       <No description available>
  660.  
  661.     ┌────────
  662.     │ OffLine           <String>
  663.     └───────────────────────────
  664.     <String> will be used for entries in a FILES.BBS where the corresponding
  665.     file is missing. This is only done, if you specified to do so in the 
  666.     template file. For further information see TEMPLATE.DOC, @OFFLINE.
  667.     The length of this string should not exceed 17 characters.
  668.  
  669. OffLine             <offline>
  670.  
  671.     ┌────────
  672.     │ LogFile           <d:\path\filename.ext>
  673.     └─────────────────────────────────────────
  674.     Path and name of logfile.
  675.     When no LogFile is specified, no log will be written at all.
  676.  
  677. LogFile             MAXLIST.LOG
  678.  
  679.     ┌─────────
  680.     │ LogLevel          <Num>
  681.     └────────────────────────
  682.     LogLevel has to be in the range 1..3. 3 is the highest level, containing
  683.     the maximum of information.
  684.  
  685. LogLevel            2
  686.  
  687.     ┌────────
  688.     │ DayName   <String String ... String>
  689.     └─────────────────────────────────────
  690.     Use this to translate names of days into a local language.
  691.     Default is in english. The first string is the name for sunday, second
  692.     monday and so on. All days must be on one line, separated by at least
  693.     one blank. Every name may consist of up to 10 chars.
  694.  
  695. DayName      Sunday Monday Tuesday Wednesday Thursday Friday Saturday
  696.  
  697.     ┌──────────
  698.     │ MonthName   <String String ... String>
  699.     └───────────────────────────────────────
  700.     Same procedure for the (abbrevated) names of months.
  701.     These may be used in the templates then (MMM). Starts with January,
  702.     every name max. 3 chars in length and separated by at least one blank.
  703.  
  704. MonthName    Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec
  705.  
  706.     ┌─────────
  707.     │ LoadFont          <d:\path\Filename.ext>
  708.     └─────────────────────────────────────────
  709.       Multiple usage possible
  710.  
  711.     This instruction tells MaxList to load a font file. The font defined
  712.     within one file may then be used in the templates. Every font is
  713.     identified by a unique name (max. 8 chars), so MaxList knows which one
  714.     to use.
  715.     To create your own fonts, use FNTMAKE(p).EXE (v1.20), which will by found
  716.     in archive FONTS.ZIP.
  717.     Please do not forget to send the good ones to the author of MaxList ;)
  718.     For detailed instructions how to use a font, see TEMPLATE.DOC,
  719.     topic @FONTSTR
  720.  
  721. LoadFont            %Font%
  722.  
  723.     ┌──────────
  724.     │ DupeCheck         <NAME | NAME.EXT>
  725.     └────────────────────────────────────
  726.     MaxList comes with a builtin dupe checking routine.
  727.     To use it, a file list of type DUPE has to be configured. In this list
  728.     MaxList will then place all dupes found, according to the template file.
  729.     As for every other list, it is possible to use Exclude and Include in the
  730.     dupe list config.
  731.     This entry now defines, HOW MaxList will check for dupes.
  732.     <NAME> will check only the name of the files, without extension.
  733.     So ABC.ZIP and ABC.ARJ will be assumed to be dupes.
  734.     <NAME.EXT> will check for files where the full name is the same.
  735.     NOTE
  736.       The dupe check has to be activated by command line parameter -D!
  737.  
  738. DupeCheck           Name
  739.  
  740.  
  741.  ┌───────────────────╖
  742.  │ Semaphore Control ╠════════════════════════════════════════════════════════
  743.  ╘═══════════════════╝
  744.  
  745.     ┌──────────────
  746.     │ SemaphoreIdle     <d:\path\filename.ext>
  747.     └─────────────────────────────────────────
  748.       Multiple usage possible
  749.  
  750.     MaxList will watch the file names specified here. When one of the given
  751.     files is found, MaxList will stop processing, until the file is deleted.
  752.  
  753. SemaphoreIdle       %Task3%
  754. SemaphoreIdle       %TaskMax1%
  755. SemaphoreIdle       %TaskMax2%
  756. SemaphoreIdle       %TaskMax3%
  757.  
  758.     ┌─────────────
  759.     │ SemaphoreRun      <d:\path\filename.ext>
  760.     └─────────────────────────────────────────
  761.     This file is created by MaxList at startup and removed at end.
  762.     Other programs may check for the existance of this file and react
  763.     accordingly.
  764.  
  765. SemaphoreRun        %Task0%
  766.  
  767.  
  768.  ┌───────────────────────────────╖
  769.  │ Path and Name of Controlfiles ╠════════════════════════════════════════════
  770.  ╘═══════════════════════════════╝
  771.  
  772.     ┌────────────
  773.     │ MaxAreaFile       <d:\path\Filename.ext>
  774.     └─────────────────────────────────────────
  775.       Multiple usage possible
  776.  
  777.     Specify all your FILEAREA.CTL files here, which MaxList has to process.
  778.     All *.CTL files which are included by Maximus INCLUDE statement are
  779.     processed automatically by MaxList, DO NOT SPECIFY THESE HERE!
  780.     The includes may be nested up to 10 levels in depth.
  781.  
  782. MaxAreaFile         D:\MAX\FILEAREA.CTL             
  783.  
  784.     ┌─────────────[v2.20]
  785.     │ MaxIndexFile      <d:\path\Filename.ext>
  786.     └─────────────────────────────────────────
  787.     This entry is only necessary, when you want create announcelists.
  788.     In this case, you must enter the full path an name of Maximus indexfile.
  789.     Normaly this is MAXFILES.IDX.
  790.  
  791. MaxIndexFile        d:\max\maxfiles.idx
  792.  
  793.     ┌─────────────[v2.20]
  794.     │ EchoTossLog       <d:\path\Filename.ext>
  795.     └─────────────────────────────────────────
  796.     This entry is only necessary, when you want to write announces directly
  797.     to the Squishbase and your Echomailtosser need it.
  798.     MaxList store a entry for each Echotag, where a mail is written in, to
  799.     this file.
  800.  
  801. EchoTossLog         d:\Bink\Log\EchoToss.Log
  802.  
  803.  
  804.     ┌──────────────[v2.20]
  805.     │ ClMaxReqIndex     <Yes | No>
  806.     └─────────────────────────────
  807.     A new Requestprocessor (CLMAXREQ) for the Mailer CANTALOUP is also
  808.     available from 'Home of MaxList'. This Requestprocessor use the FArea.dat
  809.     from Maximus 3.xx. By this, it's not necessary to create a Maximus 2
  810.     compatible Area.dat for each day.
  811.     
  812.     MaxList can create a special index for the descriptions. This index
  813.     (FILES.CMX) is used by my Requestprocessor CLMAXREQ. It's not necessary,
  814.     but speedup requestprocessing, especially at great files.bbs.
  815.     HINT!
  816.       On DEBUGG Yes, no index is created and exist files are deleted!      
  817.  
  818. ClMaxReqIndex       No
  819.  
  820.     ┌─────────────[v2.20]
  821.     │ ExternEditor      <d:\path\Filename.ext>
  822.     └─────────────────────────────────────────
  823.     Here you can enter a editor as you want. They is called, whenever a
  824.     FILE_ID.DIZ is imported and MaxList ist started wiht the -M switch.
  825.     So you can edit the description, before it's inserted into list and
  826.     files.bbs.
  827.  
  828. OS2 ExternEditor    E.EXE
  829. DOS ExternEditor    C:\NC\MVE.EXE
  830.  
  831.     ┌─────────────
  832.     │ SortAreaFile      <NONE | AREA | GROUP | BOTH>
  833.     └───────────────────────────────────────────────
  834.     SortAreaFile specifies how to sort the entries in the FILEAREA.CTL file.
  835.     The control file itself is not altered.
  836.       NONE  - no sort at all
  837.       AREA  - only area names are sorted numerical and alphabetical
  838.       GROUP - only group names are sorted numerical and alphabetical
  839.       BOTH  - sort both area and group names
  840.  
  841. SortAreaFile        Both
  842.  
  843.  
  844.  ┌────────────────────────╖
  845.  │ Areaselective Settings ╠═══════════════════════════════════════════════════
  846.  ╘════════════════════════╝
  847.  
  848.     ┌──────────
  849.     │ NoProcess         AREA <Area[ .. Area]>
  850.     │ NoProcess         FILE <Filearea.ctl>
  851.     └────────────────────────────────────────
  852.       Multiple usage possible, wildcards allowed
  853.  
  854.     Excludes the listed areas or a specific FILEAREA.CTL from processing.
  855.     Every entry matching the given parameters is completely ignored.
  856.  
  857. ifn Special
  858.   NoProcess         File    FileArea.cd
  859.   NoProcess         Area    CD.0..CD.99
  860. EndIf
  861.  
  862.     ┌─────────
  863.     │ Noformat          <Area[ .. Area]>
  864.     └───────────────────────────────────
  865.       Multiple usage possible, wildcards allowed
  866.  
  867.     This statement allows to suppress the FORMAT feature for FILES.BBS files
  868.     for the specified areas.
  869.     If you have long descriptions in your FILES.BBS files, you have to
  870.     specify NOFORMAT, if these entries should not be changed.
  871.     Otherwise MaxList will handle the descriptions as given in the @FORMAT
  872.     keyword at @FILEDESC.
  873.  
  874.     ! IMPORTANT HINT !
  875.     ──────────────────
  876.     In areas, which have a 'NoFormat', the FILES.BBS files are NEVER changed.
  877.     By this, only a 'CreateLongDesc' will make modifications on the files.bbs!
  878.     
  879. NoFormat            Listen.Text
  880.  
  881.     ┌───────────────
  882.     │ CreateLongDesc    <Area[ .. Area]>  <Maxlen>
  883.     └─────────────────────────────────────────────
  884.       Multiple usage possible, wildcards allowed
  885.  
  886.     With this token, you can create longdescriptions.
  887.     In this, MaxList will remove all grafical characters, duplicated blank
  888.     and any multiple chars, which normaly used as framecharacters.
  889.     The product is plain Ascii. The maximum lenght of this text can be
  890.     limited. Furthermore, you can arrange this text in one or multiple line.
  891.     This procedure works areaseletive.
  892.  
  893.     Following parameters you can use:
  894.       <Area [ .. Area]> denotes one or more areas.
  895.       <MaxLen>          could use in a range of 0 up to 8192. When you use a
  896.                         lenght of 0, the text is not truncated, until it's
  897.                         less than 8192 bytes (after processing).
  898.  
  899.     HINT!
  900.       When you have defined a 'NoFormat' for the correspondig areas, MaxList
  901.       will put the description in ONE line! Otherwise, the text is reformatted
  902.       to borders as defined in your BBS-Template by @FileDesc(left, right).
  903.  
  904. CreateLongDesc    *   1024
  905.  
  906.     ┌───────
  907.     │ NoSort            <Area[ .. Area]>  <FILE | LIST | BOTH>
  908.     └─────────────────────────────────────────────────────────
  909.       Multiple usage possible, wildcards allowed
  910.  
  911.     Excludes the given areas from sorting their file entries in the FILES.BBS
  912.     and/or the file lists.
  913.     
  914.       FILE - Do not sort the corresponding FILES.BBS files
  915.       LIST - Do not sort in the file lists
  916.       BOTH - No sort at all (for the given areas)
  917.  
  918. NoSort              100    BOTH
  919.  
  920.     ┌───────────────────
  921.     │ SortBetweenComment   <Area[ .. Area]>
  922.     └──────────────────────────────────────
  923.     With this, you can change the sortmethode of MaxList.
  924.     The marked areas will be sorted as long as a commentline will be
  925.     recognized. After that line, the sorting will restart from this postion.
  926.     The commentline stays therefore always at the pretend position.
  927.     HINT!
  928.       New files, which are added by AddOrphan, will be sorted in the block
  929.       afterward the last commentline.
  930.  
  931.     For all NOT marked areas, the sortmethode is executed in normaly mode.
  932.     That is, a comment will be allways put in order to the next file and it
  933.     will sort corresponding.
  934.  
  935. SortBetweenComment  *
  936.  
  937.     ┌─────────────
  938.     │ FreeDownLoad      AREA  <Area[ .. Area]>  <TIME | BYTE | BOTH>
  939.     │ FreeDownLoad      FILE  <Filename.ext>    <TIME | BYTE | BOTH>
  940.     └───────────────────────────────────────────────────────────────
  941.       Multiple usage possible, wildcards allowed
  942.  
  943.     This statement will add Maximus switches /t, /b or /tb for free download
  944.     and/or free time to the FILES.BBS entries of the given areas or files.
  945.     The parameters specified here will be used when processing a @FEEDWNLD
  946.     token in a BBS template file.
  947.  
  948.       TIME - Add /t to metching FILES.BBS entry
  949.       BYTE - Add /b to matching FILES.BBS entry
  950.       BOTH - Add /tb to matching FILES.BBS entry
  951.  
  952. FreeDownLoad        Area  100  Both
  953.  
  954.     ┌──────────────
  955.     │ RemoveOldFile     <Area[ .. Area]> <days> <BackupPath[\!A | \!P]>
  956.     └──────────────────────────────────────────────────────────────────
  957.       Multiple usage possible, wildcards allowed
  958.  
  959.     Files older than <days> will be removed from your file base.
  960.     The files and the corresponding FILES.BBS entry are moved to <BackupPath>.
  961.     Options:
  962.       \!A - BackupPath gets extended by the area tag.
  963.             If your area is called GAMESNET100, <BackupPath> gets extended by
  964.             \GAMESNET.100. Area tags longer than 12 characters are truncated.
  965.       \!P - BackupPath gets extended by the last pathname specified in UPLOAD.
  966.             If you have set UPLOAD D\BBS\LISTS\, BackupPath> gets extended
  967.             by \LISTS.
  968.  
  969.     NOTE
  970.       Areas of type CD or DATELIST will never be processed, i.e. RemoveOldFile
  971.       has no result.
  972.  
  973. RemoveOldFile       680..691  22  D:\BBSOLD\NODELIST
  974.  
  975.     ┌──────────────
  976.     │ ExcludeRemove     AREA <Area[ .. Area]>
  977.     │ ExcludeRemove     FILE <Filename.ext>
  978.     └────────────────────────────────────────
  979.       Multiple usage possible, wildcards allowed
  980.  
  981.     Files placed in AREA or files matching FILE will never be moved, even if
  982.     matching the values of RemoveOldFile.
  983.  
  984. ExcludeRemove       FILE    Test.*
  985.  
  986.     ┌──────────────
  987.     │ RemoveOffLine     <Area[ .. Area]>    [LIST]
  988.     └─────────────────────────────────────────────
  989.       Multiple usage possible, wildcards allowed
  990.       
  991.     Removes entries in the FILES.BBS where the corresponding file is missing.
  992.     If option LIST is specified, they will only suppressed in the file lists.
  993.     In this case, the FILES.BBS is not changed.
  994.     NOTE
  995.       Areas of type CD or DATELIST will NEVER be processed, also you have
  996.       a NoFormat assigned to the area.
  997.  
  998. RemoveOffline       *
  999.  
  1000.     ┌───────────────
  1001.     │ AddOrphanFiles    <Area[ .. Area]>
  1002.     └───────────────────────────────────
  1003.       Multiple usage possible, wildcards allowed
  1004.  
  1005.     Adds automatically files of the specified areas, where no entry in the
  1006.     FILES.BBS is present.
  1007.     MaxList tries to extract a FILE_ID.DIZ from the archive and use that for
  1008.     the description. If that is not possible, the string specified at
  1009.     NODESCRIPTION will be used, except when command line parameter -M is
  1010.     given. In this case MaxList will start the editor and wait for the user
  1011.     to enter the description. When savin with F3 MaxList will add the entered
  1012.     description as FILE_ID.DIZ to the archive.
  1013.                    
  1014. AddOrphanfiles      *
  1015.  
  1016.     ┌───────────────
  1017.     │ NoAutoAddFiles    <Area[ .. Area]>    <Filename.Ext>
  1018.     └─────────────────────────────────────────────────────
  1019.       Multiple usage possible, wildcards allowed
  1020.  
  1021.     Excludes file(s) from automatic adding, when found in <Area>.
  1022.                 
  1023. NoAutoAddFiles      100     Treff.*
  1024.  
  1025.     ┌──────────
  1026.     │ BBSHeader         <Area[ .. Area]>    <d:\path\Template.ext>
  1027.     └─────────────────────────────────────────────────────────────
  1028.       Multiple usage possible, wildcards allowed
  1029.  
  1030.     Specify the FILES.BBS template for an area here.
  1031.     If no template is given, an internal template is used.
  1032.  
  1033. BBSHeader           *   %Template%\BBShdr2.tpl
  1034.  
  1035.     ┌──────────────
  1036.     │ HdrInEmptyBBS     <Yes | No>  
  1037.     └─────────────────────────────
  1038.     MaxList can write a hearder into the files.bbs, even if this area
  1039.     contains no files. If it is switched to YES, MaxList will write the
  1040.     BBSHeader into the FILES.BBS, if a template assigned.
  1041.  
  1042. HdrInEmptyBBS       Yes
  1043.  
  1044.     ┌───────────────
  1045.     │ WriteBBSTypeCD    <Yes | No>
  1046.     └─────────────────────────────
  1047.     Support for Maximus 3.0 - TYPE CD.
  1048.     Over this switch you can select, wheater MaxList write files.bbs for
  1049.     areas which are marked with TYPE CD.
  1050.     When you use NO, no files.bbs will be written.
  1051.  
  1052. WriteBBSTypeCD      No
  1053.  
  1054.     ┌───────────────
  1055.     │ NoWriteFileBBS    <Area[ .. Area]>
  1056.     └───────────────────────────────────
  1057.       Multiple usage possible, wildcards allowed
  1058.  
  1059.     Same as previouse, for Maximus 2.x users.
  1060.     With this token you can select, in which areas MaxList should NOT write
  1061.     the files.bbs new.
  1062.  
  1063. NoWriteFileBBS      CD.* 
  1064.  
  1065.     ┌──────────
  1066.     │ UserLevel         <Area[ .. Area]>  <Level/Keys>  <ReplaceString>
  1067.     └──────────────────────────────────────────────────────────────────
  1068.       Multiple usage possible, wildcards allowed
  1069.  
  1070.     Use this statement to translate Maximus level/keys into a string
  1071.     (e.g. the one you use in your box). The strings are used in the templates
  1072.     at @AreaAcs / @GroupAcs.
  1073.  
  1074. UserLevel           1??         Twit/*      Guest
  1075. UserLevel           200..679    Twit/*      New User
  1076. UserLevel           692..899    Twit/*      New User
  1077. UserLevel           680..691    Twit/*      Point
  1078. UserLevel           *           Limited     Normal
  1079. UserLevel           *           Worthy/p    Point
  1080. UserLevel           *           AsstSysop   CoSysop
  1081.  
  1082.  
  1083.  ┌────────────────────────────────╖
  1084.  │ OKFiles for file request lists ╠═══════════════════════════════════════════
  1085.  ╘════════════════════════════════╝
  1086.  
  1087.     All Okfiles (request lists) are defined in a block.
  1088.     You may create several lists by entering the block several times. Note
  1089.     that the file names (without extension) for a list have to be unique then!
  1090.     Entries like SHUTTLE.KNW and SHUTTLE.UNK are NOT allowed!
  1091.  
  1092.     MaxList will create temporary files with extension .OK# during processing.
  1093.     When finished, the files are renamed to their desired name. This behaviour
  1094.     allowes file requests beeing processed when MaxList is running.
  1095.  
  1096.     Every block starts with       OKFILE  <d:\path\filename.ext>
  1097.     and ends with                 END OKFILE
  1098.     Between these two instructions additional keywords are necessary:
  1099.  
  1100.     ┌─────
  1101.     │ MODE          <SHORT | LONG | WILDCARD>
  1102.     └────────────────────────────────────────
  1103.     Specifies the type of the OKFile
  1104.  
  1105.       Format SHORT:       D:\PATH\
  1106.       Format LONG:        @FILENAME.EXT   D:\PATH\FILENAME.EXT
  1107.       Format WILDCARD:    D:\PATH\*.*
  1108.  
  1109.     ┌────────
  1110.     │ EXCLUDE       <AREA | AREAACS | GROUPACS> <Parameter>
  1111.     └──────────────────────────────────────────────────────
  1112.       Optional. Multiple usage possible. Wildcards allowed.
  1113.  
  1114.     Excludes areas or files by taking in to account:
  1115.       AREA      <Area[ .. Area]>   - areas
  1116.       AREAACS   <Level/Keys>       - level and keys of area
  1117.       GROUPACS  <Level/Keys>       - level and leys of group
  1118.  
  1119.     You may specify wildcards at all parameters. Note, that you ALWAYS have
  1120.     to specify BOTH, i.e. level AND keys at xxxACS, e.g. Normal/p, */p or
  1121.     Normal/*.
  1122.     If you want to exclude the area BACK which is present in several groups,
  1123.     you may do this by simply specifying EXCLUDE  GFD.*.BACK
  1124.  
  1125.     ┌────────
  1126.     │ INCLUDE       <AREA | AREAACS | GROUPACS> <Parameter>
  1127.     └──────────────────────────────────────────────────────
  1128.       Optional. Multiple usage possible. Wildcards allowed.
  1129.  
  1130.     Include areas previously excluded. Syntax is the same as EXCLUDE.
  1131.  
  1132.     ┌───────────[v2.20]
  1133.     │ HEADERFILE    <d:\Path\Filename.ext>
  1134.     └─────────────────────────────────────
  1135.       Optional. Multiple usage possible.
  1136.  
  1137.     The file(s) specified by this entry are included at the beginning of
  1138.     OkFile, in the order as they occur here.
  1139.  
  1140.     ┌──────────
  1141.     │ MAGICFILE     <d:\Path\Filename.ext>
  1142.     └─────────────────────────────────────
  1143.       Optional.
  1144.  
  1145.     This file, was normaly contain your magic name definitions, is copied
  1146.     to OkFile directly after all HeaderFiles.
  1147.  
  1148.     ┌───────────[v2.20]
  1149.     │ FOOTERFILE    <d:\Path\Filename.ext>
  1150.     └─────────────────────────────────────
  1151.       Optional. Multiple usage possible.
  1152.  
  1153.     The file(s) specified by this entry are written at the end of OkFile,
  1154.     in the order as they occur here.
  1155.  
  1156.     Example OKFile:
  1157.     ───────────────
  1158.       OkFile            d:\Bink\Shuttle.Ok
  1159.         Mode            WildCard
  1160.         HeaderFile      Shuttle.ban
  1161.         MagicFile       d:\Bink\Shuttle.Mag
  1162.         FooterFile      d:\Bink\Shuttle.Ftr
  1163.         Exclude         Area        Gif.*
  1164.         Include         Area        Gif.DB*
  1165.         Include         Area        Gif.Cars*
  1166.       End OKFile
  1167.  
  1168.  
  1169.  ┌──────────────────────────╖
  1170.  │ Definition of File Lists ╠═════════════════════════════════════════════════
  1171.  ╘══════════════════════════╝
  1172.  
  1173.     ┌─────────
  1174.     │ FileList          <d:\Path\Filename.ext>   <ListType>  [<Parameter>]
  1175.     └─────────────────────────────────────────────────────────────────────
  1176.     Every file list definition has to start with this entry.
  1177.     <ListType> defines the type of list to generate. Dependant on the type
  1178.     of the list, additional parameters may be necessary.
  1179.     The different types in detail:
  1180.  
  1181.       │ ALL       [Name]      - Allfiles list
  1182.       └──────────────────────────────────────
  1183.       If [Name] is specified, it will occur at token @ListTyp.
  1184.       Default is ALLFILES.
  1185.  
  1186.       │ NEW     <Days> [Name] - Newfiles list
  1187.       └──────────────────────────────────────
  1188.       In this list only files younger than <days> days are taken into account.
  1189.       If [Name] is specified, it will occur at token @ListTyp.
  1190.       Default is NEWFILES.
  1191.       
  1192.       │ PART      [Name]      - Part list
  1193.       └──────────────────────────────────
  1194.       Is a allfiles list. You may use this type in order to list only selected
  1195.       areas. If [Name] is specified, it will occur at token @ListTyp.
  1196.  
  1197.       │ REPORT    [Name]      - Statistical list
  1198.       └─────────────────────────────────────────
  1199.       You have to specify in the templates WHAT kind of data to be displayed.
  1200.       If [Name] is specified, it will occur at token @ListTyp.
  1201.       Default is REPORT.
  1202.  
  1203.       │ DUPE      [Name]      - List of dupe files
  1204.       └───────────────────────────────────────────
  1205.       This list is only created when DUPECHECK is specified and MaxList is
  1206.       started with -D option.
  1207.       If [Name] is specified, it will occur at token @ListTyp.
  1208.       Default is DUPES.
  1209.  
  1210.       │ ORPHAN    [Name]      - List of automatic added files
  1211.       └──────────────────────────────────────────────────────
  1212.       This list is created only, MaxList has added new files by AddOrphan.
  1213.       If [Name] is specified, it will occur at token @ListTyp.
  1214.       Default is ORPHAN.
  1215.  
  1216.       │ ANNOUNCE  [Name]      - List of files, which not exist in MAXFILES.INX
  1217.       └───────────────────────────────────────────────────────────────────────
  1218.       This list is allways deleted at the start of MaxList. A new list is
  1219.       created, whenever MaxList found a file, was not exist in Maximus index.
  1220.       If [Name] is specified, it will occur at token @ListTyp.
  1221.       Default is ANNOUNCE.
  1222.  
  1223.  
  1224.     ┌───────────────────────────────────────────┐
  1225.     │ Parameter inside a list definitions block ├───────────────────────────────
  1226.     └───────────────────────────────────────────┘
  1227.  
  1228.       │ ArchiveList       <ArchiverName>   [d:\Path\filename]
  1229.       └──────────────────────────────────────────────────────
  1230.       Specifies the compressor and the file name of the list.
  1231.       <ArchiverName> is the type of compressor defined in the archiver
  1232.       definition (ARCHIVER <type>)
  1233.  
  1234.       │ ListHeaderFile    <d:\path\Filename.ext>
  1235.       └─────────────────────────────────────────
  1236.         Multiple usage possible
  1237.  
  1238.       The file(s) specified by this entry are included at the beginning of
  1239.       the list, in the order as they occur here.
  1240.       You may use this to include your logo file and others.
  1241.       Then the title template is following.
  1242.  
  1243.       │ ListFooterFile    <d:\path\Filename.ext>
  1244.       └─────────────────────────────────────────
  1245.         Multiple usage possible
  1246.  
  1247.       The file(s) specified by this entry are included at the end of the list,
  1248.       in the order as they occur here and immeditately after the report footer.
  1249.       Then my copyright notice is following.
  1250.  
  1251.       │ ListTitle         <TemplateDatei>
  1252.       └──────────────────────────────────
  1253.       After the header file you may insert a title in the list, eg. the list
  1254.       type (ALLFILES, NEWFILES a.s.o.)
  1255.       Output is dependant on what you have specified in the template.
  1256.  
  1257.       │ AreaHeader        <TemplateDatei>
  1258.       │ AreaFooter        <TemplateDatei>
  1259.       └──────────────────────────────────
  1260.       AreaHeader: Header and format definition for areas.
  1261.       AreaFooter: Footer for areas.
  1262.       For details see TEMPLATE.DOC
  1263.  
  1264.       │ GroupHeader       <TemplateDatei>
  1265.       │ GroupFooter       <TemplateDatei>
  1266.       └──────────────────────────────────
  1267.       GroupHeader: Header and format description for groups in the summary.
  1268.       GroupFooter: Footer for groups.
  1269.       For details see TEMPLATE.DOC
  1270.  
  1271.       │ ReportHeader      <TemplateDatei>
  1272.       │ ReportFooter      <TemplateDatei>
  1273.       └──────────────────────────────────
  1274.       ReportHeader: Header for the statitics at the end of the list.
  1275.       ReportFooter: Issued before ListFooter.
  1276.       For details see TEMPLATE.DOC
  1277.  
  1278.       │ AllAreaReport     <Yes/No>
  1279.       └───────────────────────────
  1280.       NO: no statistics (report) is added to the list.
  1281.       This keyword has no effect at report lists. Of course ;-)
  1282.  
  1283.       │ Exclude           <AREA | FILE | AREAACS | GROUPACS>  <Parameter>
  1284.       └──────────────────────────────────────────────────────────────────
  1285.         Optional. Multiple usage possible. Wildcards allowed
  1286.  
  1287.       Excludes areas or files by taking into account:
  1288.         AREA      <Area[ .. Area]>   - areas
  1289.         FILE      <FileName.ext>     - files
  1290.         AREAACS   <Level/Keys>       - level and keys of area
  1291.         GROUPACS  <Level/Keys>       - level und keys of group
  1292.  
  1293.       You may specify wildcards at all parameters.
  1294.       When files are excluded, a comment in FILES.BBS following after that
  1295.       file will not be included in the list.
  1296.       Note, that you ALWAYS have to specify BOTH, i.e. level AND keys at
  1297.       xxxACS, e.g. Normal/p, */p or Normal/*.
  1298.       If you want to exclude the area BACK which is present in several groups,
  1299.       you may do this by simply specifying EXCLUDE  GFD.*.BACK.
  1300.  
  1301.       │ Include           <AREA | FILE | AREAACS | GROUPACS>  <Parameter>
  1302.       └──────────────────────────────────────────────────────────────────
  1303.         Optional. Multiple usage possible. Wildcards allowed
  1304.  
  1305.       Include areas or xxxACS previously excluded.
  1306.       Syntax is the same as EXCLUDE.
  1307.  
  1308.       ───────────────────────
  1309.       !! ANNOUNCELIST ONLY !!
  1310.       ───────────────────────
  1311.       Inside your announcelist the follow parameters are nescessary, if you
  1312.       want to write this list directly as a Echomail to your Squishbase:
  1313.  
  1314.       ┌──────────[v2.20]
  1315.       │ SqishMail         <YourAka>  <EchoTag>  <d:\Path\squishFile>
  1316.       └─────────────────────────────────────────────────────────────
  1317.       <YourAKA>            - Your nodenumber (Zone:Net/Node[.point])
  1318.       <EchoTag>            - The name of this echo, e.g. NEWFILES.GER
  1319.       <d:\path\SquishFile> - Path and name of .SQD file for this echo
  1320.       
  1321.  
  1322.         │ MsgHeader       "<From>"   "<To>"     "<Subject>"
  1323.         └──────────────────────────────────────────────────
  1324.         This strings are written to the messageheader. Each parameter must be
  1325.         enclosed in double quote, e.g "xyz" and separate by blanks.
  1326.  
  1327.         │ MsgOrigin       <String>
  1328.         └─────────────────────────
  1329.         Origin of your message. MaxList will allway create a origin in follow
  1330.         format:    * Origin <String> (<YourAKA>)
  1331.  
  1332.  
  1333.     ┌────
  1334.     │ END   FileList      
  1335.     └───────────────
  1336.     Needed at the end of every file list definition block
  1337.  
  1338.  
  1339.  ┌───────────────────────┐
  1340.  │ Example ALLFILES List ├────────────────────────────────────────────────────
  1341.  └───────────────────────┘
  1342.  
  1343. FileList            %MxLDir%\24442050.ALL  All
  1344.   ArchiveList       Zip     %ListDir%\2050all
  1345.   ListHeaderFile    %MxLDir%\SHUTTLE.HDR
  1346.   ListTitle         %Template%\Title.tpl
  1347.   AreaHeader        %Template%\Areahdr2.tpl
  1348.   ReportHeader      %Template%\Reprthdr.tpl
  1349.   GroupHeader       %Template%\GroupHdr.tpl
  1350.   AllAreaReport     Yes
  1351.   Exclude           Area    900..989
  1352.   Exclude           Area    999
  1353.   Exclude           AreaAcs Extra/*
  1354.   Exclude           AreaAcs */P
  1355. End FileList
  1356.  
  1357.  ┌───────────────────┐
  1358.  │ Example PART List ├────────────────────────────────────────────────────────
  1359.  └───────────────────┘
  1360.  
  1361. FileList            %MxLDir%\24442050.WOS  Part  WOS-NET
  1362.   ArchiveList       Zip     %ListDir%\2050wos
  1363.   ListHeaderFile    %MxLDir%\SHUTTLE.HDR
  1364.   ListTitle         %Template%\Title.tpl
  1365.   AreaHeader        %Template%\Areahdr2.tpl
  1366.   ReportHeader      %Template%\Reprthdr.tpl
  1367.   GroupHeader       %Template%\GroupHdr.tpl
  1368.   AllAreaReport     Yes
  1369.   Exclude           Area    *
  1370.   Include           Area    400..469
  1371. End FileList
  1372.  
  1373.  ┌───────────────────────┐
  1374.  │ Example NEWFILES List ├────────────────────────────────────────────────────
  1375.  └───────────────────────┘
  1376.  
  1377. FileList            %MxLDir%\24442050.NEW  NEW  14
  1378.   ArchiveList       Zip     %ListDir%\2050new
  1379.   ListHeaderFile    %MxLDir%\SHUTTLE.HDR
  1380.   ListTitle         %Template%\Title.tpl
  1381.   AreaHeader        %Template%\Areahdr2.tpl
  1382.   ReportHeader      %Template%\Reprthdr.tpl
  1383.   GroupHeader       %Template%\GroupHdr.tpl
  1384.   AllAreaReport     Yes
  1385.   Exclude           Area    900..989
  1386.   Exclude           Area    999
  1387.   Exclude           AreaAcs Extra/*
  1388.   Exclude           AreaAcs */P
  1389. End FileList
  1390.  
  1391.  ┌────────────────────────────────────┐
  1392.  │ Example NEWFILES List for QWK User ├───────────────────────────────────────
  1393.  └────────────────────────────────────┘
  1394.  
  1395. FileList            D:\MAX\OLR\NEWFILES.DAT  New  7
  1396.   ListHeaderFile    %MxLDir%\SHUTTLE.HDR
  1397.   ListTitle         %Template%\Title.tpl
  1398.   AreaHeader        %Template%\Areahdr2.tpl
  1399.   ReportHeader      %Template%\Reprthdr.tpl
  1400.   GroupHeader       %Template%\GroupHdr.tpl
  1401.   AllAreaReport     No
  1402.   Exclude           Area    900..989
  1403.   Exclude           Area    999
  1404.   Exclude           AreaAcs Extra/*
  1405.   Exclude           AreaAcs */P
  1406. End FileList
  1407.  
  1408.  ┌───────────────────┐
  1409.  │ Example DUPE List ├────────────────────────────────────────────────────────
  1410.  └───────────────────┘
  1411.  
  1412. FileList            %MxLDir%\24442050.DUP  Dupe
  1413.   ListTitle         %Template%\Title.tpl
  1414.   AreaHeader        %Template%\DupeHdr.tpl
  1415.   ReportHeader      %Template%\Reprthdr.tpl
  1416.   GroupHeader       %Template%\GroupHdr.tpl
  1417.   AllAreaReport     Yes
  1418.   Exclude           Area    900..989
  1419. End FileList
  1420.  
  1421.  ┌─────────────────────┐
  1422.  │ Example ORPHAN List ├──────────────────────────────────────────────────────
  1423.  └─────────────────────┘
  1424.  
  1425. FileList          %MxLDir%\24442050.ORP  ORPHAN  AutoAdd
  1426.   ListTitle       %Template%\Title.tpl
  1427.   AreaHeader      %Template%\Areahdr2.tpl
  1428.   ReportHeader    %Template%\Reprthdr.tpl
  1429.   GroupHeader     %Template%\GroupHdr.tpl
  1430.   AllAreaReport   Yes
  1431. End FileList
  1432.  
  1433.  ┌───────────────────────┐
  1434.  │ Example ANNOUNCE List ├────────────────────────────────────────────────────
  1435.  └───────────────────────┘
  1436.  
  1437. FileList          %MxLDir%\24442050.ANN  ANNOUNCE
  1438.   AreaHeader      %Template%\Areahdr2.tpl
  1439.   AllAreaReport   No
  1440.   SquishMail      2:2444/2050  Shuttle_Announce  i:\mail\shuttle\sht_Anno
  1441.     MsgHeader     "Wilfried Brinkmann"  "All Points"  "New files"
  1442.     MsgOrigin     Lets go, is nearly free ;-)
  1443.   Exclude         Area    Upload
  1444. End FileList
  1445.  
  1446. ══════════════════════════════════════════════════════════════════════════════
  1447. Wilfried Brinkmann, FidoNet 2:2444/2050               Hattingen, February 1996
  1448. ══════════════════════════════════════════════════════════════════════════════
  1449.